home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / olrdrs / clqwk100.zip / CLEANQWK.CFG next >
Text File  |  1994-05-19  |  7KB  |  204 lines
  1. ;
  2. ;                ┌────────────────────────────────────────┐
  3. ;                │   Sample CLEANQWK Configuration File   │
  4. ;                └────────────────────────────────────────┘
  5. ;
  6. ;
  7. ; Comments
  8. ; ========
  9. ;
  10. ; A semicolon is used to indicate the start of a comment.  If it appears
  11. ; at the start of a line, the whole line is ignored.  It can also be used
  12. ; after a command, to clarify the action.  Blank lines in the configuration
  13. ; file are simply ignored.
  14. ;
  15. ;
  16. ;
  17. ; Commands
  18. ; ========
  19. ;
  20. ; Each configuration setting is defined by one entry in the file, of the
  21. ; form "Command=Value".  The commands are generally case-insensitive, so
  22. ; you can enter them in CAPITALS, small letters, or Any CombInation.
  23. ; Commands may be entered in any order in the file.
  24. ;
  25. ;
  26. ;
  27. ; Multiple Configurations
  28. ; =======================
  29. ;
  30. ; When CLEANQWK is started, it looks for a CLEANQWK.CFG file in the current
  31. ; directory.  If one is found, then that configuration is used for the run.
  32. ; If no CLEANQWK.CFG file is found in the current directory, then CLEANQWK
  33. ; looks for a CLEANQWK.CFG file in the directory containing CLEANQWK.EXE.
  34. ; You can therefore select from multiple configurations by having different
  35. ; current directories when processing packages from different boards, etc.
  36. ;
  37.  
  38. ;
  39. ; Logging
  40. ; =======
  41. ;
  42. ; Logging is controlled by two commands, Log and Logfile.
  43. ;
  44. ; Log = N(one)      tells the program not to produce a log file.
  45. ; Log = O(verwrite) tells the program to create a new log file, or to
  46. ;                   overwrite the log file if it already exists
  47. ; Log = A(ppend)    tells the program to append the log for this run to
  48. ;                   an existing log file.  If no log file exists, then
  49. ;                   one will be created.
  50. ;
  51. ; If Log = Overwrite or Log = Append is specified, you may specify the name
  52. ; of the log file to be used with the Logfile command.  The format is:-
  53. ;    Logfile = <file name>
  54. ; where <file name> can be either a simple file name (in which case it will
  55. ; be created in the current directory), or a full path name, such as:-
  56. ;    Logfile = c:\mydir\cleanup.log
  57. ; Note: Specified directories must exist; the program will not create them.
  58. ;
  59. Log = Append            ; default: append to existing log file
  60. Logfile = cleanqwk.log  ; default: file "cleanqwk.log" in current directory
  61.  
  62.  
  63. ;
  64. ; Backup Files
  65. ; ============
  66. ;
  67. ; Specifying Backup = Y(es) will tell the program to create a backup copy
  68. ; of the original QWK packet, before making any changes.  The name of the
  69. ; backup file will be the same as the original file, with extension .BAK.
  70. ; If Backup = N(o) is specified, no backup will be made.
  71. ;
  72. Backup = Yes            ; default is "Make Backup Files"
  73.  
  74.  
  75. ;
  76. ; .NDX Files
  77. ; ==========
  78. ;
  79. ; Specifying Ndxfiles = Y(es) will cause the program to create index (.NDX)
  80. ; files, regardless of whether or not any .NDX files were included in the
  81. ; original QWK packet.
  82. ; You can use this feature to speed up your download by configuring the
  83. ; mail door not to download .NDX files.
  84. ; if Ndxfiles = N(o), the "massaged" packet will contain no .NDX files, and
  85. ; it will be left to your mail reader program to build its own indexes.
  86. ;
  87. Ndxfiles = Yes          ; default is "Create Index Files"
  88.  
  89.  
  90. ;
  91. ; Duplicate Messages
  92. ; ==================
  93. ;
  94. ; Beginners often forget to delete their REP files and end up posting the
  95. ; same message more than once.
  96. ; Advanced users who have news items that they think will be of interest
  97. ; in more than one newsgroup may post the same message to more than one
  98. ; newsgroup.
  99. ; Either way, you may end up with multiple copies of the same message in
  100. ; your packet.
  101. ; CLEANQWK can delete all copies of any message already found in the QWK
  102. ; packet if requested to do so, so that you only need to read the message
  103. ; once.  To enable this option, specify:-
  104. ;    Duplicates = Kill
  105. ; If you don't want duplicate messages to be deleted, specify:-
  106. ;    Duplicates = Ignore
  107. ;
  108. Duplicates = Kill       ; default: kill all duplicates
  109.  
  110.  
  111. ;
  112. ; Which internet/Usenet header lines to retain
  113. ; ============================================
  114. ;
  115. ; Up to 20 header lines may be marked to be kept.  They will appear in the
  116. ; message in the order in which they are specified here, regardless of the
  117. ; order in which they appeared in the original message.
  118. ;
  119. Keep = From:            ; keep "From:" line
  120. Keep = Subject:         ; keep "Subject:" line
  121.  
  122.  
  123. ;
  124. ; Highlight Character
  125. ; ===================
  126. ;
  127. ; If you like, CLEANQWK will flag each retained internet header line with
  128. ; a specified ASCII character in column 1 so that these lines will be
  129. ; highlighted in your reader as if they have been quoted.
  130. ; To enable this, specify "highlight=<number>", where <number> is the ASCII
  131. ; value (between 1 and 254) of the character you prefer.
  132. ; To disable highlighting, specify "highlight=0".
  133. ;
  134. Highlight = 175         ; default: highlight character is 175 ("»")
  135.  
  136.  
  137. ;
  138. ; Aliases
  139. ; =======
  140. ;
  141. ; Provided that Ndxfiles is set to Yes, you can specify up to 20 "aliases"
  142. ; to be considered as personal messages.  This is useful if you use any
  143. ; aliases yourself, or if you want all messages to or from some "special
  144. ; person" to be considered as personal.
  145. ;
  146. ; Each "alias" is specified as one line, of the form:-
  147. ;   Alias = <name>
  148. ;
  149. ; There are no default aliases.  If no .NDX files are to be created, then
  150. ; all aliases are ignored.
  151. ;
  152.  
  153.  
  154. ;
  155. ; Readdressing Messages
  156. ; =====================
  157. ;
  158. ; A few offline readers (notably Speed Read) totally ignore the Personal
  159. ; index in the packet, and generate their own, which means that the
  160. ; "Alias" feature of CLEANQWK gets ignored.
  161. ;
  162. ; If you find that this is happening, then you can tell CLEANQWK to
  163. ; readdress all "Alias" messages to you directly, and add a line to the
  164. ; top of each such message indicating the original addressee.
  165. ;
  166. ; To enable this option, specify "Readdress=Yes".
  167. ;
  168. Readdress = No          ; default: reader will believe CLEANQWK
  169.  
  170.  
  171. ;
  172. ; Messages addressed to "ALL"
  173. ; ===========================
  174. ;
  175. ; If messages addressed to "ALL" in specific conferences are of major
  176. ; interest, these can be readdressed to the conference name as it appears
  177. ; on the BBS.  These messages can then be brought into your personal
  178. ; conference by means of the "Alias" statement described above, using the
  179. ; conference name as the alias, eg "Alias=Main Board"
  180. ;
  181. ; To enable readdressing messages to "All", specify "All2Conf=Y(es)"
  182. ;
  183. All2Conf = No
  184.  
  185.  
  186. ;
  187. ; Twits
  188. ; =====
  189. ;
  190. ; Every board has its collection of idiots who write large numbers of stupid
  191. ; messages.  CLEANQWK can eliminate the irritation of reading their rubbish
  192. ; by eliminating all messages from them, as well as all messages addressed
  193. ; to these individuals.
  194. ;
  195. ; A maximum of 20 "twits" can be defined.
  196. ;
  197. Twit = Paved Roads      ; There are no default twits in the program,
  198. Twit = Grass Hopper     ; but here are a couple of examples
  199.  
  200.  
  201. ;
  202. ; ******************* End of Sample Configuration File ******************
  203. ;
  204.